<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Jetson Inference: InputDevices Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="NVLogo_2D.jpg"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Jetson Inference
   </div>
   <div id="projectbrief">DNN Vision Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classInputDevices.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classInputDevices-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">InputDevices Class Reference<div class="ingroups"><a class="el" href="group__util.html">Utilities Library (jetson-utils)</a> &raquo; <a class="el" href="group__input.html">Input</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Input device manager.  
 <a href="classInputDevices.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="devInput_8h_source.html">devInput.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aee59f4de36c7953b7aced9b4d0d8fe9e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInputDevices.html#aee59f4de36c7953b7aced9b4d0d8fe9e">~InputDevices</a> ()</td></tr>
<tr class="memdesc:aee59f4de36c7953b7aced9b4d0d8fe9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#aee59f4de36c7953b7aced9b4d0d8fe9e">More...</a><br /></td></tr>
<tr class="separator:aee59f4de36c7953b7aced9b4d0d8fe9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40fd94440d7d89fbfd96b84db63887ad"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInputDevices.html#a40fd94440d7d89fbfd96b84db63887ad">Poll</a> (uint32_t timeout=0)</td></tr>
<tr class="memdesc:a40fd94440d7d89fbfd96b84db63887ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Poll the devices for updates.  <a href="#a40fd94440d7d89fbfd96b84db63887ad">More...</a><br /></td></tr>
<tr class="separator:a40fd94440d7d89fbfd96b84db63887ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4980776694d32de85b4ed9b956a9911"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKeyboardDevice.html">KeyboardDevice</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInputDevices.html#ab4980776694d32de85b4ed9b956a9911">GetKeyboard</a> () const</td></tr>
<tr class="memdesc:ab4980776694d32de85b4ed9b956a9911"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the keyboard device.  <a href="#ab4980776694d32de85b4ed9b956a9911">More...</a><br /></td></tr>
<tr class="separator:ab4980776694d32de85b4ed9b956a9911"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adef03b03e7fc4519dacf48220d83a7e9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classJoystickDevice.html">JoystickDevice</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInputDevices.html#adef03b03e7fc4519dacf48220d83a7e9">GetJoystick</a> () const</td></tr>
<tr class="memdesc:adef03b03e7fc4519dacf48220d83a7e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the gamepad device.  <a href="#adef03b03e7fc4519dacf48220d83a7e9">More...</a><br /></td></tr>
<tr class="separator:adef03b03e7fc4519dacf48220d83a7e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53de9667014046b098706f119843f7f9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInputDevices.html#a53de9667014046b098706f119843f7f9">Debug</a> (bool enabled=true)</td></tr>
<tr class="memdesc:a53de9667014046b098706f119843f7f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable/disable verbose logging.  <a href="#a53de9667014046b098706f119843f7f9">More...</a><br /></td></tr>
<tr class="separator:a53de9667014046b098706f119843f7f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a3e09be2fb85b398317b7ce4825d7e08a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classInputDevices.html">InputDevices</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInputDevices.html#a3e09be2fb85b398317b7ce4825d7e08a">Create</a> ()</td></tr>
<tr class="memdesc:a3e09be2fb85b398317b7ce4825d7e08a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create device.  <a href="#a3e09be2fb85b398317b7ce4825d7e08a">More...</a><br /></td></tr>
<tr class="separator:a3e09be2fb85b398317b7ce4825d7e08a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab67ffc55bf1814816ae735ce0290e66c"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInputDevices.html#ab67ffc55bf1814816ae735ce0290e66c">Enumerate</a> (<a class="el" href="group__input.html#ga50538a4d144ab00657372f458f9c3cb4">DeviceList</a> &amp;devices)</td></tr>
<tr class="memdesc:ab67ffc55bf1814816ae735ce0290e66c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scan /dev/input for devices.  <a href="#ab67ffc55bf1814816ae735ce0290e66c">More...</a><br /></td></tr>
<tr class="separator:ab67ffc55bf1814816ae735ce0290e66c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8a0bed652968f7ad9e48f5a5b828504"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInputDevices.html#aa8a0bed652968f7ad9e48f5a5b828504">FindPathByName</a> (const char *name)</td></tr>
<tr class="memdesc:aa8a0bed652968f7ad9e48f5a5b828504"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find /dev/input path by device name.  <a href="#aa8a0bed652968f7ad9e48f5a5b828504">More...</a><br /></td></tr>
<tr class="separator:aa8a0bed652968f7ad9e48f5a5b828504"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a4acecf026f4b289c7bb30f983706e79a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInputDevices.html#a4acecf026f4b289c7bb30f983706e79a">InputDevices</a> ()</td></tr>
<tr class="separator:a4acecf026f4b289c7bb30f983706e79a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a667e29a70249c6760b63fadc18e5f742"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKeyboardDevice.html">KeyboardDevice</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInputDevices.html#a667e29a70249c6760b63fadc18e5f742">mKeyboard</a></td></tr>
<tr class="separator:a667e29a70249c6760b63fadc18e5f742"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a850a23a3141e106df63b35bd94c536d0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classJoystickDevice.html">JoystickDevice</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInputDevices.html#a850a23a3141e106df63b35bd94c536d0">mJoystick</a></td></tr>
<tr class="separator:a850a23a3141e106df63b35bd94c536d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adba1404d096e9c71455fef530554dd3e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInputDevices.html#adba1404d096e9c71455fef530554dd3e">mDebug</a></td></tr>
<tr class="separator:adba1404d096e9c71455fef530554dd3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Input device manager. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aee59f4de36c7953b7aced9b4d0d8fe9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee59f4de36c7953b7aced9b4d0d8fe9e">&#9670;&nbsp;</a></span>~InputDevices()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">InputDevices::~InputDevices </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destructor. </p>

</div>
</div>
<a id="a4acecf026f4b289c7bb30f983706e79a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4acecf026f4b289c7bb30f983706e79a">&#9670;&nbsp;</a></span>InputDevices()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">InputDevices::InputDevices </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3e09be2fb85b398317b7ce4825d7e08a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e09be2fb85b398317b7ce4825d7e08a">&#9670;&nbsp;</a></span>Create()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classInputDevices.html">InputDevices</a>* InputDevices::Create </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Create device. </p>

</div>
</div>
<a id="a53de9667014046b098706f119843f7f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53de9667014046b098706f119843f7f9">&#9670;&nbsp;</a></span>Debug()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void InputDevices::Debug </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>enabled</em> = <code>true</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enable/disable verbose logging. </p>

</div>
</div>
<a id="ab67ffc55bf1814816ae735ce0290e66c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab67ffc55bf1814816ae735ce0290e66c">&#9670;&nbsp;</a></span>Enumerate()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void InputDevices::Enumerate </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__input.html#ga50538a4d144ab00657372f458f9c3cb4">DeviceList</a> &amp;&#160;</td>
          <td class="paramname"><em>devices</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Scan /dev/input for devices. </p>

</div>
</div>
<a id="aa8a0bed652968f7ad9e48f5a5b828504"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8a0bed652968f7ad9e48f5a5b828504">&#9670;&nbsp;</a></span>FindPathByName()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static std::string InputDevices::FindPathByName </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Find /dev/input path by device name. </p>

</div>
</div>
<a id="adef03b03e7fc4519dacf48220d83a7e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adef03b03e7fc4519dacf48220d83a7e9">&#9670;&nbsp;</a></span>GetJoystick()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classJoystickDevice.html">JoystickDevice</a>* InputDevices::GetJoystick </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Retrieve the gamepad device. </p>

</div>
</div>
<a id="ab4980776694d32de85b4ed9b956a9911"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4980776694d32de85b4ed9b956a9911">&#9670;&nbsp;</a></span>GetKeyboard()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classKeyboardDevice.html">KeyboardDevice</a>* InputDevices::GetKeyboard </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Retrieve the keyboard device. </p>

</div>
</div>
<a id="a40fd94440d7d89fbfd96b84db63887ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40fd94440d7d89fbfd96b84db63887ad">&#9670;&nbsp;</a></span>Poll()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool InputDevices::Poll </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>timeout</em> = <code>0</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Poll the devices for updates. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="adba1404d096e9c71455fef530554dd3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adba1404d096e9c71455fef530554dd3e">&#9670;&nbsp;</a></span>mDebug</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool InputDevices::mDebug</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a850a23a3141e106df63b35bd94c536d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a850a23a3141e106df63b35bd94c536d0">&#9670;&nbsp;</a></span>mJoystick</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classJoystickDevice.html">JoystickDevice</a>* InputDevices::mJoystick</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a667e29a70249c6760b63fadc18e5f742"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a667e29a70249c6760b63fadc18e5f742">&#9670;&nbsp;</a></span>mKeyboard</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classKeyboardDevice.html">KeyboardDevice</a>* InputDevices::mKeyboard</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>jetson-utils/<a class="el" href="devInput_8h_source.html">devInput.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classInputDevices.html">InputDevices</a></li>
    <li class="footer">Generated on Thu Sep 26 2019 12:19:12 for Jetson Inference by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
